/*
 * #%L
 * Server
 * %%
 * Copyright (C) 2011 Ractoc.com
 * %%
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 *      http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 * #L%
 */
package com.ractoc.opengamefinder.server.plugins.messages;

import com.ractoc.pffj.api.BasePluginMessage;

/**
 * This message reports a closed session to the various plugins on the server
 * that are interested in such an event. This is the SessionPlugin by default,
 * but it is also possibl to register other plugins for this even through the
 * plugin config xml.
 * 
 * @author ractoc
 * @version 0.1
 */
public final class CloseSessionMessage extends BasePluginMessage {

    private static final long serialVersionUID = -7718625417457021476L;

    private int sessionId;
    private int playerId;

    /**
     * Default constructor.
     */
    public CloseSessionMessage() {
    }

    /**
     * Get the session id of the session being closed.
     * @return The session id of the session being closed.
     */
    public int getSessionId() {
        return sessionId;
    }

    /**
     * Set the session id of the session being closed.
     * @param sessionIdParam The session id of the session being closed.
     */
    public void setSessionId(final int sessionIdParam) {
        this.sessionId = sessionIdParam;
    }

    /**
     * Set the player id linked to the session being closed.
     * @param playerIdParam The player id linked to the session being closed.
     */
    public void setPlayerId(final int playerIdParam) {
        this.playerId = playerIdParam;
    }

    /**
     * Get the player id linked to the session being closed.
     * @return The player id linked to the session being closed.
     */
    public int getPlayerId() {
        return playerId;
    }

}
